Update 02-branching.md #57
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wxtim
reviewed
Jan 31, 2025
|
|
||
| #### Cons | ||
|
|
||
| - Very steep learning curve, not suitable for novices | ||
| - Very steep learning curve, not suitable for novices. |
There was a problem hiding this comment.
I don't think that we want to word this so strongly - I expect most of our user base are perfectly capable of managing it, and I don't want people to be put off using it when appropriate, or scaring people whose projects require it.
Suggested change
| - Very steep learning curve, not suitable for novices. | |
| - Steeper learning curve, novices may require more help. |
wxtim
reviewed
Jan 31, 2025
| @@ -68,22 +68,28 @@ where the developers make changes. | |||
| Once the feature is done, they submit a pull request and | |||
| merge it into the `main` branch after review. | |||
| Feature branches should be relatively short-lived. | |||
| Each collaborator must be given **write** level, or higher, permissions | |||
There was a problem hiding this comment.
Suggested change
| Each collaborator must be given **write** level, or higher, permissions | |
| Each collaborator must have **write** level, or higher, permissions |
wxtim
reviewed
Jan 31, 2025
Comment on lines
+77
to
+78
| - Each feature is developed away from `main` so you don't affect production code. | ||
| - Multiple features can be developed in parallel feature branches. |
There was a problem hiding this comment.
Suggested change
| - Each feature is developed away from `main` so you don't affect production code. | |
| - Multiple features can be developed in parallel feature branches. | |
| - Developers create each feature away from `main` so you don't affect production code. | |
| - Developers can create many features can in parallel feature branches. |
wxtim
reviewed
Jan 31, 2025
Comment on lines
+90
to
+92
| Note that all branches and commits exist within the single GitHub, ***origin***, repository | ||
| (and are therefore easily visible by anyone who has read access to the repository) | ||
| and any contributor can write to any branch that has not been explicitly protected. |
There was a problem hiding this comment.
Suggested change
| Note that all branches and commits exist within the single GitHub, ***origin***, repository | |
| (and are therefore easily visible by anyone who has read access to the repository) | |
| and any contributor can write to any branch that has not been explicitly protected. | |
| Note that all branches and commits exist within the single GitHub, origin repository. | |
| They are visible to anyone who has read access to the repository. | |
| Any contributor can write to any branch that is not explicitly protected. |
wxtim
reviewed
Jan 31, 2025
Comment on lines
+163
to
+165
| Note that all branches and commits exist within the collaborators fork, not the ***upstream*** repository | ||
| (and are therefore less visible to anyone who has read access to the upstream repository). | ||
| Collaborators can use their fork to test more complex changes, including for example testing github actions within a dummy-PR. |
There was a problem hiding this comment.
Suggested change
| Note that all branches and commits exist within the collaborators fork, not the ***upstream*** repository | |
| (and are therefore less visible to anyone who has read access to the upstream repository). | |
| Collaborators can use their fork to test more complex changes, including for example testing github actions within a dummy-PR. | |
| All branches and commits exist within the collaborators fork, not the ***upstream*** repository. They are harder to find for anyone who has read access to the upstream repository. | |
| Collaborators can use their fork to test more complex changes. For example testing github actions within a dummy-PR. |
wxtim
approved these changes
Jan 31, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #54
I have tried to follow the discussion in #54, let me know if I left anything out. @ehogan @wxtim @mo-marqh.